3 * Localisation cache storage based on PHP files and static arrays.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use Wikimedia\StaticArrayWriter
;
28 class LCStoreStaticArray
implements LCStore
{
29 /** @var string|null Current language code. */
30 private $currentLang = null;
32 /** @var array Localisation data. */
35 /** @var string File name. */
36 private $fname = null;
38 /** @var string Directory for cache files. */
41 public function __construct( $conf = [] ) {
42 global $wgCacheDirectory;
44 $this->directory
= $conf['directory'] ??
$wgCacheDirectory;
47 public function startWrite( $code ) {
48 if ( !file_exists( $this->directory
) ) {
49 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
50 throw new MWException( "Unable to create the localisation store " .
51 "directory \"{$this->directory}\"" );
55 $this->currentLang
= $code;
56 $this->fname
= $this->directory
. '/' . $code . '.l10n.php';
57 $this->data
[$code] = [];
58 if ( file_exists( $this->fname
) ) {
59 $this->data
[$code] = require $this->fname
;
63 public function set( $key, $value ) {
64 $this->data
[$this->currentLang
][$key] = self
::encode( $value );
68 * Encodes a value into an array format
72 * @throws RuntimeException
74 public static function encode( $value ) {
75 if ( is_array( $value ) ) {
77 return [ 'a', array_map( 'LCStoreStaticArray::encode', $value ) ];
79 if ( is_object( $value ) ) {
81 return [ 's', serialize( $value ) ];
83 if ( is_scalar( $value ) ||
$value === null ) {
84 // Scalar value, written directly without array
88 throw new RuntimeException( 'Cannot encode ' . var_export( $value, true ) );
92 * Decode something that was encoded with encode
94 * @param mixed $encoded
96 * @throws RuntimeException
98 public static function decode( $encoded ) {
99 if ( !is_array( $encoded ) ) {
100 // Scalar values are written directly without array
104 list( $type, $data ) = $encoded;
108 return array_map( 'LCStoreStaticArray::decode', $data );
110 return unserialize( $data );
112 // Support: MediaWiki 1.32 and earlier
113 // Backward compatibility with older file format
116 throw new RuntimeException(
117 'Unable to decode ' . var_export( $encoded, true ) );
121 public function finishWrite() {
122 $writer = new StaticArrayWriter();
123 $out = $writer->create(
124 $this->data
[$this->currentLang
],
125 'Generated by LCStoreStaticArray.php -- do not edit!'
127 file_put_contents( $this->fname
, $out );
128 $this->currentLang
= null;
132 public function get( $code, $key ) {
133 if ( !array_key_exists( $code, $this->data
) ) {
134 $fname = $this->directory
. '/' . $code . '.l10n.php';
135 if ( !file_exists( $fname ) ) {
138 $this->data
[$code] = require $fname;
140 $data = $this->data
[$code];
141 if ( array_key_exists( $key, $data ) ) {
142 return self
::decode( $data[$key] );